/**
 * MINAPL Compiler.
 * Copyright 2012 Michael A. Muller
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef _minapl_Token_h_
#define _minapl_Token_h_

#include <unistd.h>

namespace minapl {

enum TokType {
    TOK_INVAL,
    TOK_END,
    TOK_ID,
    TOK_INT,
    TOK_STR,
    TOK_SEMI,
    TOK_LPAREN,
    TOK_RPAREN,
    TOK_LCURLY,
    TOK_RCURLY,
    TOK_DOT
};

/// A text token.
struct Token {
    TokType type;
    int lineNum;
    char *text;
    size_t size;

    Token() : type(TOK_INVAL) {}

    void dump();

    /**
     * returns the length of the token's representation.
     */
    int repLen();

    void toRep(char *buffer);

    // Copy the text of the token and return it as an allocated null
    // terminated string.
    char *copyText();

    bool isTerminator() {
        return type == TOK_SEMI || type == TOK_RPAREN || type == TOK_RCURLY ||
               type == TOK_END;
    }
};

} // namespace minapl

#endif
